Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Cm/docs pmap #218

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
Open

Cm/docs pmap #218

wants to merge 8 commits into from

Conversation

quffaro
Copy link
Member

@quffaro quffaro commented Mar 23, 2024

This branch was created when main had docs which were formatted agreeably with Literate. Therefore the other branches related to this task, pending inspection, should be disregarded. This make.jl file partially automates adding examples to our docs. In a future branch:

  • write the make.jl file to be completely automated
  • fix literate examples (some have undefined operators, etc.). I will raise issues to fix them.

@quffaro quffaro requested a review from jpfairbanks March 23, 2024 11:06
Copy link

codecov bot commented Mar 23, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 77.75%. Comparing base (6160295) to head (67f20b8).
Report is 7 commits behind head on main.

❗ Current head 67f20b8 differs from pull request most recent head 447a5a7. Consider uploading reports for the commit 447a5a7 to get more accurate results

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #218      +/-   ##
==========================================
+ Coverage   75.13%   77.75%   +2.62%     
==========================================
  Files           5        5              
  Lines         559      562       +3     
==========================================
+ Hits          420      437      +17     
+ Misses        139      125      -14     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Member

@jpfairbanks jpfairbanks left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Talk starting.

@@ -0,0 +1,2734 @@
# This file is machine-generated - editing it directly is not advised
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We shouldn't check in the docs manifest.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@lukem12345 do we still need this file, or did it get upstreamed?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is upstreamed. The file that includes this sharp implementation should have its include of this removed, and the generate function can also get pruned.

push!(pages, "Overview" => "overview.md")
push!(pages, "Equations" => "equations.md")
push!(pages, "BC Debug" => "bc_debug.md")
push!(pages, "ASCII Operators" => "ascii.md")
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

since this part is being hard coded, it could still be a Vector{Pair{String,String}} literal and then you can push to it for the dynamically generated part later.

docs/make.jl Outdated
# end
# # push!(examples, exampledirs[d] => dir_dict)
#end
#push!(pages, "Examples" => examples)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

remove dead code.

docs/make.jl Outdated
# ],
# "Canonical Models" => "canon.md",
# "Library Reference" => "api.md"
# ]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ded code

@@ -1,528 +0,0 @@
# Halfar's model of glacial flow
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why did we delete this page?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It looks like docs\src\grigoriev.md was errantly git mv’d to docs\src\climate\ice_dynamics.md, and the real docs\src\ice_dynamics.md was deleted.

@lukem12345
Copy link
Member

It looks like the history for grigoriev.md is incorrect now

@jpfairbanks
Copy link
Member

Comment out the brusselator example and see if works @quffaro

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants